home *** CD-ROM | disk | FTP | other *** search
/ Aminet 5 / Aminet 5 - March 1995.iso / Aminet / dev / basic / RIBlitzLibs.lha / riblitzlibs / docs / RIListLib.doc < prev    next >
Encoding:
Text File  |  1995-01-30  |  4.9 KB  |  167 lines
  1. -----------------------------------------------------------------------------
  2. ====                   RI LinkList Library V0.91ß (C)1995          ====
  3. -----------------------------------------------------------------------------
  4.  
  5.                           Written By Steven Matty
  6.                         ©1995 Leading Edge Software
  7.  
  8.  
  9. NOTICE:
  10. =======
  11.  
  12. This library is currently in the very EARLY testing stage, so PLEASE do not
  13. rely on the stability/continuity in the future. It can and probably WILL change
  14. in the future. Especially dont rely on the structure of the linked list nodes
  15. to remain the same - they have already changed since V0.9ß.
  16.  
  17. All commands can be optionally used as functions, eg. suc=<command>(params)
  18. (EXCEPT: AddrListItem)
  19.  
  20. WARNING!
  21. ========
  22. Do NOT use list numbers of 5 or higher! Your machine will crash if you try.
  23. Future version will check for this.
  24.  
  25.  
  26. Command List:
  27.  
  28.         InitList list#,var
  29.         AddListItem list#
  30.         DelListItem list#
  31.         SetListItem list#,var
  32.         GetListItem list#,var
  33.         NextListItem list#
  34.         PrevListItem list#
  35.         FirstListItem list#
  36.         LastListItem list#
  37.         AddFirstListItem list#
  38.         AddLastListItem list#
  39.         ad.l=AddrListItem(list#)
  40.  
  41.  
  42. Statement/Function: InitList
  43. ------------------------------------------------------------------------------
  44. Mode   : Amiga/Blitz
  45. Syntax : InitList list#,var
  46.  
  47. This command will initialize a linked list for your use. It will also
  48. add the first node (which will contain the contents of <var>).
  49. list# must be less than five. This command optionally returns 0 for failure,
  50. or -1 for success.
  51.  
  52.  
  53. Statement/Function: AddListItem
  54. -------------------------------------------------------------------------------
  55. Mode   : Amiga/Blitz
  56. Sytnax : AddListItem list#
  57.  
  58. This command will attempt to add another item onto your list at the current
  59. position. This command optionally returns 0 for failure (no list initalized or
  60. not enough RAM) or -1 for success.
  61.  
  62.  
  63. Statement/Function: DelListItem
  64. -------------------------------------------------------------------------------
  65. Mode   : Amiga/Blitz
  66. Syntax : DelListItem list#
  67.  
  68. This command will attempt to delete the current item from your list. If the
  69. current item is the ONLY item then this command will fail. (To be fixed in
  70. later version). -1 means success.
  71.  
  72.  
  73. Statement/Function: SetListItem
  74. -------------------------------------------------------------------------------
  75. Mode   : Amiga/Blitz
  76. Syntax : SetListItem list#,var
  77.  
  78. This command will store the contents of <var> into the current node (created
  79. by AddNode). -1 means success.
  80.  
  81.  
  82. Statement/Function: GetListItem
  83. -------------------------------------------------------------------------------
  84. Mode   : Amiga/Blitz
  85. Syntax : GetListItem list#,var
  86.  
  87. This command will store the contents of the current list item into your variable
  88. specified by <var>. -1 means success
  89.  
  90.  
  91. Statement/Function: NextListItem
  92. -------------------------------------------------------------------------------
  93. Mode   : Amiga/Blitz
  94. Syntax : NextListItem list#
  95.  
  96. This command will move you onto the next item in your list. 0 indicates
  97. failure (no list/end of list) or -1 for success.
  98.  
  99.  
  100. Statement/Function: PrevListItem
  101. -------------------------------------------------------------------------------
  102. Mode   : Amiga/Blitz
  103. Syntax : PrevListItem list#
  104.  
  105. This command will move you back to the previous item in your list. 0 indicates
  106. failure (no list/start of list) or -1 for success.
  107.  
  108.  
  109. Statement/Function: FirstListItem
  110. -------------------------------------------------------------------------------
  111. Mode   : Amiga/Blitz
  112. Syntax : FirstListItem list#
  113.  
  114. This command will take you to the first item in your list. 0 indicates failure
  115. (no list) or -1 for success.
  116.  
  117.  
  118. Statement/Function: LastListItem
  119. -------------------------------------------------------------------------------
  120. Mode   : Amiga/Blitz
  121. Syntax : LastListItem list#
  122.  
  123. This command will take you to the last item in your list. 0 indicates failure
  124. (no list) or -1 for success.
  125.  
  126.  
  127. Statement/Function: AddFirstListItem
  128. -------------------------------------------------------------------------------
  129. Mode   : Amiga/Blitz
  130. Syntax : AddFirstListItem list#
  131.  
  132. This command will insert a node to the front of your list. 0 indicates failure
  133. (no list/no RAM) or -1 for success.
  134.  
  135.  
  136. Statement/Function: AddLastListItem
  137. -------------------------------------------------------------------------------
  138. Mode   : Amiga/Blitz
  139. Syntax : AddLastListItem list#
  140.  
  141. This command will add a node to the end of your list. 0 indicates failure (no
  142. list/no RAM) or -1 for success.
  143.  
  144.  
  145. Function: AddrListItem
  146. -------------------------------------------------------------------------------
  147. Mode   : Amiga/Blitz
  148. Syntax : ad.l=AddrListItem(list#)
  149.  
  150. This function will return the address of the current node in your list.
  151.  
  152.  
  153.  
  154. Version Details
  155. ===============
  156.  
  157. Version 0.9 (22/1/95)
  158. ---------------------
  159. First Release. No Docs.
  160.  
  161.  
  162. Version 0.91 (29/1/95)
  163. ----------------------
  164. Modified format of nodes to mirror exec lists. Should be ok to use
  165. in Gadtools Listviews etc...(UNTESTED).
  166. Added AddrListItem command which returns address of current item.
  167.